home *** CD-ROM | disk | FTP | other *** search
/ PC World 2006 July & August / PCWorld_2006-07-08_cd.bin / komunikace / apache / apache_2[1].2.2-win32-x86-no_ssl.msi / Data1.cab / _56FF76434E424DFB9C954A8E25AE59FD < prev    next >
Text File  |  2006-04-21  |  65KB  |  1,849 lines
  1. /* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
  2.  * applicable.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  *     http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Unless required by applicable law or agreed to in writing, software
  11.  * distributed under the License is distributed on an "AS IS" BASIS,
  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13.  * See the License for the specific language governing permissions and
  14.  * limitations under the License.
  15.  */
  16.  
  17. /**
  18.  * @file httpd.h
  19.  * @brief HTTP Daemon routines
  20.  *
  21.  * @defgroup APACHE Apache
  22.  *
  23.  * Top level group of which all other groups are a member
  24.  * @{
  25.  *
  26.  * @defgroup APACHE_MODS Apache Modules
  27.  *           Top level group for Apache Modules
  28.  * @defgroup APACHE_OS Operating System Specific
  29.  * @defgroup APACHE_CORE Apache Core
  30.  * @{
  31.  * @defgroup APACHE_CORE_DAEMON HTTP Daemon Routine
  32.  * @{
  33.  */
  34.  
  35. #ifndef APACHE_HTTPD_H
  36. #define APACHE_HTTPD_H
  37.  
  38. /* XXX - We need to push more stuff to other .h files, or even .c files, to
  39.  * make this file smaller
  40.  */
  41.  
  42. /* Headers in which EVERYONE has an interest... */
  43. #include "ap_config.h"
  44. #include "ap_mmn.h"
  45.  
  46. #include "ap_release.h"
  47.  
  48. #include "apr.h"
  49. #include "apr_general.h"
  50. #include "apr_tables.h"
  51. #include "apr_pools.h"
  52. #include "apr_time.h"
  53. #include "apr_network_io.h"
  54. #include "apr_buckets.h"
  55. #include "apr_poll.h"
  56.  
  57. #include "os.h"
  58.  
  59. #include "ap_regex.h"
  60.  
  61. #if APR_HAVE_STDLIB_H
  62. #include <stdlib.h>
  63. #endif
  64.  
  65. /* Note: apr_uri.h is also included, see below */
  66.  
  67. #ifdef __cplusplus
  68. extern "C" {
  69. #endif
  70.  
  71. #ifdef CORE_PRIVATE
  72.  
  73. /* ----------------------------- config dir ------------------------------ */
  74.  
  75. /** Define this to be the default server home dir. Most things later in this
  76.  * file with a relative pathname will have this added.
  77.  */
  78. #ifndef HTTPD_ROOT
  79. #ifdef OS2
  80. /** Set default for OS/2 file system */
  81. #define HTTPD_ROOT "/os2httpd"
  82. #elif defined(WIN32)
  83. /** Set default for Windows file system */
  84. #define HTTPD_ROOT "/apache"
  85. #elif defined (BEOS)
  86. /** Set the default for BeOS */
  87. #define HTTPD_ROOT "/boot/home/apache"
  88. #elif defined (NETWARE)
  89. /** Set the default for NetWare */
  90. #define HTTPD_ROOT "/apache"
  91. #else
  92. /** Set for all other OSs */
  93. #define HTTPD_ROOT "/usr/local/apache"
  94. #endif
  95. #endif /* HTTPD_ROOT */
  96.  
  97. /* 
  98.  * --------- You shouldn't have to edit anything below this line ----------
  99.  *
  100.  * Any modifications to any defaults not defined above should be done in the 
  101.  * respective configuration file. 
  102.  *
  103.  */
  104.  
  105. /** 
  106.  * Default location of documents.  Can be overridden by the DocumentRoot
  107.  * directive.
  108.  */
  109. #ifndef DOCUMENT_LOCATION
  110. #ifdef OS2
  111. /* Set default for OS/2 file system */
  112. #define DOCUMENT_LOCATION  HTTPD_ROOT "/docs"
  113. #else
  114. /* Set default for non OS/2 file system */
  115. #define DOCUMENT_LOCATION  HTTPD_ROOT "/htdocs"
  116. #endif
  117. #endif /* DOCUMENT_LOCATION */
  118.  
  119. /** Maximum number of dynamically loaded modules */
  120. #ifndef DYNAMIC_MODULE_LIMIT
  121. #define DYNAMIC_MODULE_LIMIT 128
  122. #endif
  123.  
  124. /** Default administrator's address */
  125. #define DEFAULT_ADMIN "[no address given]"
  126.  
  127. /** The name of the log files */
  128. #ifndef DEFAULT_ERRORLOG
  129. #if defined(OS2) || defined(WIN32)
  130. #define DEFAULT_ERRORLOG "logs/error.log"
  131. #else
  132. #define DEFAULT_ERRORLOG "logs/error_log"
  133. #endif
  134. #endif /* DEFAULT_ERRORLOG */
  135.  
  136. /** Define this to be what your per-directory security files are called */
  137. #ifndef DEFAULT_ACCESS_FNAME
  138. #ifdef OS2
  139. /* Set default for OS/2 file system */
  140. #define DEFAULT_ACCESS_FNAME "htaccess"
  141. #else
  142. #define DEFAULT_ACCESS_FNAME ".htaccess"
  143. #endif
  144. #endif /* DEFAULT_ACCESS_FNAME */
  145.  
  146. /** The name of the server config file */
  147. #ifndef SERVER_CONFIG_FILE
  148. #define SERVER_CONFIG_FILE "conf/httpd.conf"
  149. #endif
  150.  
  151. /** The default path for CGI scripts if none is currently set */
  152. #ifndef DEFAULT_PATH
  153. #define DEFAULT_PATH "/bin:/usr/bin:/usr/ucb:/usr/bsd:/usr/local/bin"
  154. #endif
  155.  
  156. /** The path to the suExec wrapper, can be overridden in Configuration */
  157. #ifndef SUEXEC_BIN
  158. #define SUEXEC_BIN  HTTPD_ROOT "/bin/suexec"
  159. #endif
  160.  
  161. /** The timeout for waiting for messages */
  162. #ifndef DEFAULT_TIMEOUT
  163. #define DEFAULT_TIMEOUT 300 
  164. #endif
  165.  
  166. /** The timeout for waiting for keepalive timeout until next request */
  167. #ifndef DEFAULT_KEEPALIVE_TIMEOUT
  168. #define DEFAULT_KEEPALIVE_TIMEOUT 5
  169. #endif
  170.  
  171. /** The number of requests to entertain per connection */
  172. #ifndef DEFAULT_KEEPALIVE
  173. #define DEFAULT_KEEPALIVE 100
  174. #endif
  175.  
  176. /*
  177.  * Limits on the size of various request items.  These limits primarily
  178.  * exist to prevent simple denial-of-service attacks on a server based
  179.  * on misuse of the protocol.  The recommended values will depend on the
  180.  * nature of the server resources -- CGI scripts and database backends
  181.  * might require large values, but most servers could get by with much
  182.  * smaller limits than we use below.  The request message body size can
  183.  * be limited by the per-dir config directive LimitRequestBody.
  184.  *
  185.  * Internal buffer sizes are two bytes more than the DEFAULT_LIMIT_REQUEST_LINE
  186.  * and DEFAULT_LIMIT_REQUEST_FIELDSIZE below, which explains the 8190.
  187.  * These two limits can be lowered (but not raised) by the server config
  188.  * directives LimitRequestLine and LimitRequestFieldsize, respectively.
  189.  *
  190.  * DEFAULT_LIMIT_REQUEST_FIELDS can be modified or disabled (set = 0) by
  191.  * the server config directive LimitRequestFields.
  192.  */
  193.  
  194. /** default limit on bytes in Request-Line (Method+URI+HTTP-version) */
  195. #ifndef DEFAULT_LIMIT_REQUEST_LINE
  196. #define DEFAULT_LIMIT_REQUEST_LINE 8190
  197. #endif 
  198. /** default limit on bytes in any one header field  */
  199. #ifndef DEFAULT_LIMIT_REQUEST_FIELDSIZE
  200. #define DEFAULT_LIMIT_REQUEST_FIELDSIZE 8190
  201. #endif 
  202. /** default limit on number of request header fields */
  203. #ifndef DEFAULT_LIMIT_REQUEST_FIELDS
  204. #define DEFAULT_LIMIT_REQUEST_FIELDS 100
  205. #endif 
  206.  
  207. /**
  208.  * The default default character set name to add if AddDefaultCharset is
  209.  * enabled.  Overridden with AddDefaultCharsetName.
  210.  */
  211. #define DEFAULT_ADD_DEFAULT_CHARSET_NAME "iso-8859-1"
  212.  
  213. #endif /* CORE_PRIVATE */
  214.  
  215. /** default HTTP Server protocol */
  216. #define AP_SERVER_PROTOCOL "HTTP/1.1"
  217.  
  218.  
  219. /* ------------------ stuff that modules are allowed to look at ----------- */
  220.  
  221. /** Define this to be what your HTML directory content files are called */
  222. #ifndef AP_DEFAULT_INDEX
  223. #define AP_DEFAULT_INDEX "index.html"
  224. #endif
  225.  
  226.  
  227. /** 
  228.  * Define this to be what type you'd like returned for files with unknown 
  229.  * suffixes.  
  230.  * @warning MUST be all lower case. 
  231.  */
  232. #ifndef DEFAULT_CONTENT_TYPE
  233. #define DEFAULT_CONTENT_TYPE "text/plain"
  234. #endif
  235.  
  236. /** The name of the MIME types file */
  237. #ifndef AP_TYPES_CONFIG_FILE
  238. #define AP_TYPES_CONFIG_FILE "conf/mime.types"
  239. #endif
  240.  
  241. /*
  242.  * Define the HTML doctype strings centrally.
  243.  */
  244. /** HTML 2.0 Doctype */
  245. #define DOCTYPE_HTML_2_0  "<!DOCTYPE HTML PUBLIC \"-//IETF//" \
  246.                           "DTD HTML 2.0//EN\">\n"
  247. /** HTML 3.2 Doctype */
  248. #define DOCTYPE_HTML_3_2  "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  249.                           "DTD HTML 3.2 Final//EN\">\n"
  250. /** HTML 4.0 Strict Doctype */
  251. #define DOCTYPE_HTML_4_0S "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  252.                           "DTD HTML 4.0//EN\"\n" \
  253.                           "\"http://www.w3.org/TR/REC-html40/strict.dtd\">\n"
  254. /** HTML 4.0 Transitional Doctype */
  255. #define DOCTYPE_HTML_4_0T "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  256.                           "DTD HTML 4.0 Transitional//EN\"\n" \
  257.                           "\"http://www.w3.org/TR/REC-html40/loose.dtd\">\n"
  258. /** HTML 4.0 Frameset Doctype */
  259. #define DOCTYPE_HTML_4_0F "<!DOCTYPE HTML PUBLIC \"-//W3C//" \
  260.                           "DTD HTML 4.0 Frameset//EN\"\n" \
  261.                           "\"http://www.w3.org/TR/REC-html40/frameset.dtd\">\n"
  262. /** XHTML 1.0 Strict Doctype */
  263. #define DOCTYPE_XHTML_1_0S "<!DOCTYPE html PUBLIC \"-//W3C//" \
  264.                            "DTD XHTML 1.0 Strict//EN\"\n" \
  265.                            "\"http://www.w3.org/TR/xhtml1/DTD/" \
  266.                            "xhtml1-strict.dtd\">\n"
  267. /** XHTML 1.0 Transitional Doctype */
  268. #define DOCTYPE_XHTML_1_0T "<!DOCTYPE html PUBLIC \"-//W3C//" \
  269.                            "DTD XHTML 1.0 Transitional//EN\"\n" \
  270.                            "\"http://www.w3.org/TR/xhtml1/DTD/" \
  271.                            "xhtml1-transitional.dtd\">\n"
  272. /** XHTML 1.0 Frameset Doctype */
  273. #define DOCTYPE_XHTML_1_0F "<!DOCTYPE html PUBLIC \"-//W3C//" \
  274.                            "DTD XHTML 1.0 Frameset//EN\"\n" \
  275.                            "\"http://www.w3.org/TR/xhtml1/DTD/" \
  276.                            "xhtml1-frameset.dtd\">"
  277.  
  278. /** Internal representation for a HTTP protocol number, e.g., HTTP/1.1 */
  279. #define HTTP_VERSION(major,minor) (1000*(major)+(minor))
  280. /** Major part of HTTP protocol */
  281. #define HTTP_VERSION_MAJOR(number) ((number)/1000)
  282. /** Minor part of HTTP protocol */
  283. #define HTTP_VERSION_MINOR(number) ((number)%1000)
  284.  
  285. /* -------------- Port number for server running standalone --------------- */
  286.  
  287. /** default HTTP Port */
  288. #define DEFAULT_HTTP_PORT    80
  289. /** default HTTPS Port */
  290. #define DEFAULT_HTTPS_PORT    443
  291. /**
  292.  * Check whether @a port is the default port for the request @a r.
  293.  * @param port The port number
  294.  * @param r The request
  295.  * @see #ap_default_port
  296.  */
  297. #define ap_is_default_port(port,r)    ((port) == ap_default_port(r))
  298. /**
  299.  * Get the default port for a request (which depends on the scheme).
  300.  * @param r The request
  301.  */
  302. #define ap_default_port(r)    ap_run_default_port(r)
  303. /**
  304.  * Get the scheme for a request.
  305.  * @param r The request
  306.  */
  307. #define ap_http_scheme(r)    ap_run_http_scheme(r)
  308.  
  309. /** The default string length */
  310. #define MAX_STRING_LEN HUGE_STRING_LEN
  311.  
  312. /** The length of a Huge string */
  313. #define HUGE_STRING_LEN 8192
  314.  
  315. /** The size of the server's internal read-write buffers */
  316. #define AP_IOBUFSIZE 8192
  317.  
  318. /** The max number of regex captures that can be expanded by ap_pregsub */
  319. #define AP_MAX_REG_MATCH 10
  320.  
  321. /**
  322.  * APR_HAS_LARGE_FILES introduces the problem of spliting sendfile into 
  323.  * mutiple buckets, no greater than MAX(apr_size_t), and more granular 
  324.  * than that in case the brigade code/filters attempt to read it directly.
  325.  * ### 16mb is an invention, no idea if it is reasonable.
  326.  */
  327. #define AP_MAX_SENDFILE 16777216  /* 2^24 */
  328.  
  329. /**
  330.  * Special Apache error codes. These are basically used
  331.  *  in http_main.c so we can keep track of various errors.
  332.  *        
  333.  */
  334. /** a normal exit */
  335. #define APEXIT_OK        0x0
  336. /** A fatal error arising during the server's init sequence */
  337. #define APEXIT_INIT        0x2
  338. /**  The child died during its init sequence */
  339. #define APEXIT_CHILDINIT    0x3
  340. /**  
  341.  *   The child exited due to a resource shortage.
  342.  *   The parent should limit the rate of forking until
  343.  *   the situation is resolved.
  344.  */
  345. #define APEXIT_CHILDSICK        0x7
  346. /** 
  347.  *     A fatal error, resulting in the whole server aborting.
  348.  *     If a child exits with this error, the parent process
  349.  *     considers this a server-wide fatal error and aborts.
  350.  */
  351. #define APEXIT_CHILDFATAL    0xf
  352.  
  353. #ifndef AP_DECLARE
  354. /**
  355.  * Stuff marked #AP_DECLARE is part of the API, and intended for use
  356.  * by modules. Its purpose is to allow us to add attributes that
  357.  * particular platforms or compilers require to every exported function.
  358.  */
  359. # define AP_DECLARE(type)    type
  360. #endif
  361.  
  362. #ifndef AP_DECLARE_NONSTD
  363. /**
  364.  * Stuff marked #AP_DECLARE_NONSTD is part of the API, and intended for
  365.  * use by modules.  The difference between #AP_DECLARE and
  366.  * #AP_DECLARE_NONSTD is that the latter is required for any functions
  367.  * which use varargs or are used via indirect function call.  This
  368.  * is to accomodate the two calling conventions in windows dlls.
  369.  */
  370. # define AP_DECLARE_NONSTD(type)    type
  371. #endif
  372. #ifndef AP_DECLARE_DATA
  373. # define AP_DECLARE_DATA
  374. #endif
  375.  
  376. #ifndef AP_MODULE_DECLARE
  377. # define AP_MODULE_DECLARE(type)    type
  378. #endif
  379. #ifndef AP_MODULE_DECLARE_NONSTD
  380. # define AP_MODULE_DECLARE_NONSTD(type)  type
  381. #endif
  382. #ifndef AP_MODULE_DECLARE_DATA
  383. # define AP_MODULE_DECLARE_DATA
  384. #endif
  385.  
  386. /**
  387.  * @internal
  388.  * modules should not use functions marked AP_CORE_DECLARE
  389.  */
  390. #ifndef AP_CORE_DECLARE
  391. # define AP_CORE_DECLARE    AP_DECLARE
  392. #endif
  393.  
  394. /**
  395.  * @internal
  396.  * modules should not use functions marked AP_CORE_DECLARE_NONSTD
  397.  */
  398.  
  399. #ifndef AP_CORE_DECLARE_NONSTD
  400. # define AP_CORE_DECLARE_NONSTD    AP_DECLARE_NONSTD
  401. #endif
  402.  
  403. /** 
  404.  * @brief The numeric version information is broken out into fields within this 
  405.  * structure. 
  406.  */
  407. typedef struct {
  408.     int major;              /**< major number */
  409.     int minor;              /**< minor number */
  410.     int patch;              /**< patch number */
  411.     const char *add_string; /**< additional string like "-dev" */
  412. } ap_version_t;
  413.  
  414. /**
  415.  * Return httpd's version information in a numeric form.
  416.  *
  417.  *  @param version Pointer to a version structure for returning the version
  418.  *                 information.
  419.  */
  420. AP_DECLARE(void) ap_get_server_revision(ap_version_t *version);
  421.  
  422. /**
  423.  * Get the server version string
  424.  * @return The server version string
  425.  */
  426. AP_DECLARE(const char *) ap_get_server_version(void);
  427.  
  428. /**
  429.  * Add a component to the version string
  430.  * @param pconf The pool to allocate the component from
  431.  * @param component The string to add
  432.  */
  433. AP_DECLARE(void) ap_add_version_component(apr_pool_t *pconf, const char *component);
  434.  
  435. /**
  436.  * Get the date a time that the server was built
  437.  * @return The server build time string
  438.  */
  439. AP_DECLARE(const char *) ap_get_server_built(void);
  440.  
  441. #define DECLINED -1        /**< Module declines to handle */
  442. #define DONE -2            /**< Module has served the response completely 
  443.                  *  - it's safe to die() with no more output
  444.                  */
  445. #define OK 0            /**< Module has handled this stage. */
  446.  
  447.  
  448. /**
  449.  * @defgroup HTTP_Status HTTP Status Codes
  450.  * @{
  451.  */
  452. /**
  453.  * The size of the static array in http_protocol.c for storing
  454.  * all of the potential response status-lines (a sparse table).
  455.  * A future version should dynamically generate the apr_table_t at startup.
  456.  */
  457. #define RESPONSE_CODES 57
  458.  
  459. #define HTTP_CONTINUE                      100
  460. #define HTTP_SWITCHING_PROTOCOLS           101
  461. #define HTTP_PROCESSING                    102
  462. #define HTTP_OK                            200
  463. #define HTTP_CREATED                       201
  464. #define HTTP_ACCEPTED                      202
  465. #define HTTP_NON_AUTHORITATIVE             203
  466. #define HTTP_NO_CONTENT                    204
  467. #define HTTP_RESET_CONTENT                 205
  468. #define HTTP_PARTIAL_CONTENT               206
  469. #define HTTP_MULTI_STATUS                  207
  470. #define HTTP_MULTIPLE_CHOICES              300
  471. #define HTTP_MOVED_PERMANENTLY             301
  472. #define HTTP_MOVED_TEMPORARILY             302
  473. #define HTTP_SEE_OTHER                     303
  474. #define HTTP_NOT_MODIFIED                  304
  475. #define HTTP_USE_PROXY                     305
  476. #define HTTP_TEMPORARY_REDIRECT            307
  477. #define HTTP_BAD_REQUEST                   400
  478. #define HTTP_UNAUTHORIZED                  401
  479. #define HTTP_PAYMENT_REQUIRED              402
  480. #define HTTP_FORBIDDEN                     403
  481. #define HTTP_NOT_FOUND                     404
  482. #define HTTP_METHOD_NOT_ALLOWED            405
  483. #define HTTP_NOT_ACCEPTABLE                406
  484. #define HTTP_PROXY_AUTHENTICATION_REQUIRED 407
  485. #define HTTP_REQUEST_TIME_OUT              408
  486. #define HTTP_CONFLICT                      409
  487. #define HTTP_GONE                          410
  488. #define HTTP_LENGTH_REQUIRED               411
  489. #define HTTP_PRECONDITION_FAILED           412
  490. #define HTTP_REQUEST_ENTITY_TOO_LARGE      413
  491. #define HTTP_REQUEST_URI_TOO_LARGE         414
  492. #define HTTP_UNSUPPORTED_MEDIA_TYPE        415
  493. #define HTTP_RANGE_NOT_SATISFIABLE         416
  494. #define HTTP_EXPECTATION_FAILED            417
  495. #define HTTP_UNPROCESSABLE_ENTITY          422
  496. #define HTTP_LOCKED                        423
  497. #define HTTP_FAILED_DEPENDENCY             424
  498. #define HTTP_UPGRADE_REQUIRED              426
  499. #define HTTP_INTERNAL_SERVER_ERROR         500
  500. #define HTTP_NOT_IMPLEMENTED               501
  501. #define HTTP_BAD_GATEWAY                   502
  502. #define HTTP_SERVICE_UNAVAILABLE           503
  503. #define HTTP_GATEWAY_TIME_OUT              504
  504. #define HTTP_VERSION_NOT_SUPPORTED         505
  505. #define HTTP_VARIANT_ALSO_VARIES           506
  506. #define HTTP_INSUFFICIENT_STORAGE          507
  507. #define HTTP_NOT_EXTENDED                  510
  508.  
  509. /** is the status code informational */
  510. #define ap_is_HTTP_INFO(x)         (((x) >= 100)&&((x) < 200))
  511. /** is the status code OK ?*/
  512. #define ap_is_HTTP_SUCCESS(x)      (((x) >= 200)&&((x) < 300))
  513. /** is the status code a redirect */
  514. #define ap_is_HTTP_REDIRECT(x)     (((x) >= 300)&&((x) < 400))
  515. /** is the status code a error (client or server) */
  516. #define ap_is_HTTP_ERROR(x)        (((x) >= 400)&&((x) < 600))
  517. /** is the status code a client error  */
  518. #define ap_is_HTTP_CLIENT_ERROR(x) (((x) >= 400)&&((x) < 500))
  519. /** is the status code a server error  */
  520. #define ap_is_HTTP_SERVER_ERROR(x) (((x) >= 500)&&((x) < 600))
  521.  
  522. /** should the status code drop the connection */
  523. #define ap_status_drops_connection(x) \
  524.                                    (((x) == HTTP_BAD_REQUEST)           || \
  525.                                     ((x) == HTTP_REQUEST_TIME_OUT)      || \
  526.                                     ((x) == HTTP_LENGTH_REQUIRED)       || \
  527.                                     ((x) == HTTP_REQUEST_ENTITY_TOO_LARGE) || \
  528.                                     ((x) == HTTP_REQUEST_URI_TOO_LARGE) || \
  529.                                     ((x) == HTTP_INTERNAL_SERVER_ERROR) || \
  530.                                     ((x) == HTTP_SERVICE_UNAVAILABLE) || \
  531.                     ((x) == HTTP_NOT_IMPLEMENTED))
  532. /** @} */
  533.  
  534. /**
  535.  * @defgroup Methods List of Methods recognized by the server
  536.  * @ingroup APACHE_CORE_DAEMON
  537.  * @{
  538.  *
  539.  * @brief Methods recognized (but not necessarily handled) by the server.
  540.  *
  541.  * These constants are used in bit shifting masks of size int, so it is
  542.  * unsafe to have more methods than bits in an int.  HEAD == M_GET.
  543.  * This list must be tracked by the list in http_protocol.c in routine
  544.  * ap_method_name_of().
  545.  *
  546.  */
  547.  
  548. #define M_GET                   0       /** RFC 2616: HTTP */
  549. #define M_PUT                   1       /*  :             */
  550. #define M_POST                  2
  551. #define M_DELETE                3
  552. #define M_CONNECT               4
  553. #define M_OPTIONS               5
  554. #define M_TRACE                 6       /** RFC 2616: HTTP */
  555. #define M_PATCH                 7       /** no rfc(!)  ### remove this one? */
  556. #define M_PROPFIND              8       /** RFC 2518: WebDAV */
  557. #define M_PROPPATCH             9       /*  :               */
  558. #define M_MKCOL                 10
  559. #define M_COPY                  11
  560. #define M_MOVE                  12
  561. #define M_LOCK                  13
  562. #define M_UNLOCK                14      /** RFC 2518: WebDAV */
  563. #define M_VERSION_CONTROL       15      /** RFC 3253: WebDAV Versioning */
  564. #define M_CHECKOUT              16      /*  :                          */
  565. #define M_UNCHECKOUT            17
  566. #define M_CHECKIN               18
  567. #define M_UPDATE                19
  568. #define M_LABEL                 20
  569. #define M_REPORT                21
  570. #define M_MKWORKSPACE           22
  571. #define M_MKACTIVITY            23
  572. #define M_BASELINE_CONTROL      24
  573. #define M_MERGE                 25
  574. #define M_INVALID               26      /** RFC 3253: WebDAV Versioning */
  575.  
  576. /**
  577.  * METHODS needs to be equal to the number of bits
  578.  * we are using for limit masks.
  579.  */
  580. #define METHODS     64
  581.  
  582. /**
  583.  * The method mask bit to shift for anding with a bitmask.
  584.  */
  585. #define AP_METHOD_BIT ((apr_int64_t)1)
  586. /** @} */
  587.  
  588.  
  589. /** @see ap_method_list_t */
  590. typedef struct ap_method_list_t ap_method_list_t;
  591.  
  592. /**
  593.  * @struct ap_method_list_t
  594.  * @brief  Structure for handling HTTP methods.  
  595.  *
  596.  * Methods known to the server are accessed via a bitmask shortcut; 
  597.  * extension methods are handled by an array.
  598.  */
  599. struct ap_method_list_t {
  600.     /** The bitmask used for known methods */
  601.     apr_int64_t method_mask;
  602.     /** the array used for extension methods */
  603.     apr_array_header_t *method_list;
  604. };
  605.  
  606. /**
  607.  * @defgroup module_magic Module Magic mime types
  608.  * @{
  609.  */
  610. /** Magic for mod_cgi[d] */
  611. #define CGI_MAGIC_TYPE "application/x-httpd-cgi"
  612. /** Magic for mod_include */
  613. #define INCLUDES_MAGIC_TYPE "text/x-server-parsed-html"
  614. /** Magic for mod_include */
  615. #define INCLUDES_MAGIC_TYPE3 "text/x-server-parsed-html3"
  616. /** Magic for mod_dir */
  617. #define DIR_MAGIC_TYPE "httpd/unix-directory"
  618.  
  619. /** @} */
  620. /* Just in case your linefeed isn't the one the other end is expecting. */
  621. #if !APR_CHARSET_EBCDIC
  622. /** linefeed */
  623. #define LF 10
  624. /** carrige return */
  625. #define CR 13
  626. /** carrige return /Line Feed Combo */
  627. #define CRLF "\015\012"
  628. #else /* APR_CHARSET_EBCDIC */
  629. /* For platforms using the EBCDIC charset, the transition ASCII->EBCDIC is done
  630.  * in the buff package (bread/bputs/bwrite).  Everywhere else, we use
  631.  * "native EBCDIC" CR and NL characters. These are therefore
  632.  * defined as
  633.  * '\r' and '\n'.
  634.  */
  635. #define CR '\r'
  636. #define LF '\n'
  637. #define CRLF "\r\n"
  638. #endif /* APR_CHARSET_EBCDIC */                                   
  639.  
  640. /**
  641.  * @defgroup values_request_rec_body Possible values for request_rec.read_body 
  642.  * @{
  643.  * Possible values for request_rec.read_body (set by handling module):
  644.  */
  645.  
  646. /** Send 413 error if message has any body */
  647. #define REQUEST_NO_BODY          0
  648. /** Send 411 error if body without Content-Length */
  649. #define REQUEST_CHUNKED_ERROR    1
  650. /** If chunked, remove the chunks for me. */
  651. #define REQUEST_CHUNKED_DECHUNK  2
  652. /** @} // values_request_rec_body */
  653.  
  654. /**
  655.  * @defgroup values_request_rec_used_path_info Possible values for request_rec.used_path_info 
  656.  * @ingroup APACHE_CORE_DAEMON
  657.  * @{
  658.  * Possible values for request_rec.used_path_info:
  659.  */
  660.  
  661. /** Accept the path_info from the request */
  662. #define AP_REQ_ACCEPT_PATH_INFO    0
  663. /** Return a 404 error if path_info was given */
  664. #define AP_REQ_REJECT_PATH_INFO    1
  665. /** Module may chose to use the given path_info */
  666. #define AP_REQ_DEFAULT_PATH_INFO   2
  667.  
  668. /** @} // values_request_rec_used_path_info */
  669.  
  670.  
  671. /*
  672.  * Things which may vary per file-lookup WITHIN a request ---
  673.  * e.g., state of MIME config.  Basically, the name of an object, info
  674.  * about the object, and any other info we may ahve which may need to
  675.  * change as we go poking around looking for it (e.g., overridden by
  676.  * .htaccess files).
  677.  *
  678.  * Note how the default state of almost all these things is properly
  679.  * zero, so that allocating it with pcalloc does the right thing without
  680.  * a whole lot of hairy initialization... so long as we are willing to
  681.  * make the (fairly) portable assumption that the bit pattern of a NULL
  682.  * pointer is, in fact, zero.
  683.  */
  684.  
  685. /**
  686.  * @brief This represents the result of calling htaccess; these are cached for
  687.  * each request.
  688.  */
  689. struct htaccess_result {
  690.     /** the directory to which this applies */
  691.     const char *dir;
  692.     /** the overrides allowed for the .htaccess file */
  693.     int override;
  694.     /** the override options allowed for the .htaccess file */
  695.     int override_opts;
  696.     /** the configuration directives */
  697.     struct ap_conf_vector_t *htaccess;
  698.     /** the next one, or NULL if no more; N.B. never change this */
  699.     const struct htaccess_result *next;
  700. };
  701.  
  702. /* The following four types define a hierarchy of activities, so that
  703.  * given a request_rec r you can write r->connection->server->process
  704.  * to get to the process_rec.  While this reduces substantially the
  705.  * number of arguments that various hooks require beware that in
  706.  * threaded versions of the server you must consider multiplexing
  707.  * issues.  */
  708.  
  709.  
  710. /** A structure that represents one process */
  711. typedef struct process_rec process_rec;
  712. /** A structure that represents a virtual server */
  713. typedef struct server_rec server_rec;
  714. /** A structure that represents one connection */
  715. typedef struct conn_rec conn_rec;
  716. /** A structure that represents the current request */
  717. typedef struct request_rec request_rec;
  718. /** A structure that represents the status of the current connection */
  719. typedef struct conn_state_t conn_state_t;
  720.  
  721. /* ### would be nice to not include this from httpd.h ... */
  722. /* This comes after we have defined the request_rec type */
  723. #include "apr_uri.h"
  724.  
  725. /** 
  726.  * @brief A structure that represents one process 
  727.  */
  728. struct process_rec {
  729.     /** Global pool. Cleared upon normal exit */
  730.     apr_pool_t *pool;
  731.     /** Configuration pool. Cleared upon restart */
  732.     apr_pool_t *pconf;
  733.     /** Number of command line arguments passed to the program */
  734.     int argc;
  735.     /** The command line arguments */
  736.     const char * const *argv;
  737.     /** The program name used to execute the program */
  738.     const char *short_name;
  739. };
  740.  
  741. /** 
  742.  * @brief A structure that represents the current request 
  743.  */
  744. struct request_rec {
  745.     /** The pool associated with the request */
  746.     apr_pool_t *pool;
  747.     /** The connection to the client */
  748.     conn_rec *connection;
  749.     /** The virtual host for this request */
  750.     server_rec *server;
  751.  
  752.     /** Pointer to the redirected request if this is an external redirect */
  753.     request_rec *next;
  754.     /** Pointer to the previous request if this is an internal redirect */
  755.     request_rec *prev;
  756.  
  757.     /** Pointer to the main request if this is a sub-request
  758.      * (see http_request.h) */
  759.     request_rec *main;
  760.  
  761.     /* Info about the request itself... we begin with stuff that only
  762.      * protocol.c should ever touch...
  763.      */
  764.     /** First line of request */
  765.     char *the_request;
  766.     /** HTTP/0.9, "simple" request (e.g. GET /foo\n w/no headers) */
  767.     int assbackwards;
  768.     /** A proxy request (calculated during post_read_request/translate_name)
  769.      *  possible values PROXYREQ_NONE, PROXYREQ_PROXY, PROXYREQ_REVERSE,
  770.      *                  PROXYREQ_RESPONSE
  771.      */
  772.     int proxyreq;
  773.     /** HEAD request, as opposed to GET */
  774.     int header_only;
  775.     /** Protocol string, as given to us, or HTTP/0.9 */
  776.     char *protocol;
  777.     /** Protocol version number of protocol; 1.1 = 1001 */
  778.     int proto_num;
  779.     /** Host, as set by full URI or Host: */
  780.     const char *hostname;
  781.  
  782.     /** Time when the request started */
  783.     apr_time_t request_time;
  784.  
  785.     /** Status line, if set by script */
  786.     const char *status_line;
  787.     /** Status line */
  788.     int status;
  789.  
  790.     /* Request method, two ways; also, protocol, etc..  Outside of protocol.c,
  791.      * look, but don't touch.
  792.      */
  793.  
  794.     /** Request method (eg. GET, HEAD, POST, etc.) */
  795.     const char *method;
  796.     /** M_GET, M_POST, etc. */
  797.     int method_number;
  798.  
  799.     /**
  800.      *  'allowed' is a bitvector of the allowed methods.
  801.      *
  802.      *  A handler must ensure that the request method is one that
  803.      *  it is capable of handling.  Generally modules should DECLINE
  804.      *  any request methods they do not handle.  Prior to aborting the
  805.      *  handler like this the handler should set r->allowed to the list
  806.      *  of methods that it is willing to handle.  This bitvector is used
  807.      *  to construct the "Allow:" header required for OPTIONS requests,
  808.      *  and HTTP_METHOD_NOT_ALLOWED and HTTP_NOT_IMPLEMENTED status codes.
  809.      *
  810.      *  Since the default_handler deals with OPTIONS, all modules can
  811.      *  usually decline to deal with OPTIONS.  TRACE is always allowed,
  812.      *  modules don't need to set it explicitly.
  813.      *
  814.      *  Since the default_handler will always handle a GET, a
  815.      *  module which does *not* implement GET should probably return
  816.      *  HTTP_METHOD_NOT_ALLOWED.  Unfortunately this means that a Script GET
  817.      *  handler can't be installed by mod_actions.
  818.      */
  819.     apr_int64_t allowed;
  820.     /** Array of extension methods */
  821.     apr_array_header_t *allowed_xmethods; 
  822.     /** List of allowed methods */
  823.     ap_method_list_t *allowed_methods; 
  824.  
  825.     /** byte count in stream is for body */
  826.     apr_off_t sent_bodyct;
  827.     /** body byte count, for easy access */
  828.     apr_off_t bytes_sent;
  829.     /** Last modified time of the requested resource */
  830.     apr_time_t mtime;
  831.  
  832.     /* HTTP/1.1 connection-level features */
  833.  
  834.     /** sending chunked transfer-coding */
  835.     int chunked;
  836.     /** The Range: header */
  837.     const char *range;
  838.     /** The "real" content length */
  839.     apr_off_t clength;
  840.  
  841.     /** Remaining bytes left to read from the request body */
  842.     apr_off_t remaining;
  843.     /** Number of bytes that have been read  from the request body */
  844.     apr_off_t read_length;
  845.     /** Method for reading the request body
  846.      * (eg. REQUEST_CHUNKED_ERROR, REQUEST_NO_BODY,
  847.      *  REQUEST_CHUNKED_DECHUNK, etc...) */
  848.     int read_body;
  849.     /** reading chunked transfer-coding */
  850.     int read_chunked;
  851.     /** is client waiting for a 100 response? */
  852.     unsigned expecting_100;
  853.  
  854.     /* MIME header environments, in and out.  Also, an array containing
  855.      * environment variables to be passed to subprocesses, so people can
  856.      * write modules to add to that environment.
  857.      *
  858.      * The difference between headers_out and err_headers_out is that the
  859.      * latter are printed even on error, and persist across internal redirects
  860.      * (so the headers printed for ErrorDocument handlers will have them).
  861.      *
  862.      * The 'notes' apr_table_t is for notes from one module to another, with no
  863.      * other set purpose in mind...
  864.      */
  865.  
  866.     /** MIME header environment from the request */
  867.     apr_table_t *headers_in;
  868.     /** MIME header environment for the response */
  869.     apr_table_t *headers_out;
  870.     /** MIME header environment for the response, printed even on errors and
  871.      * persist across internal redirects */
  872.     apr_table_t *err_headers_out;
  873.     /** Array of environment variables to be used for sub processes */
  874.     apr_table_t *subprocess_env;
  875.     /** Notes from one module to another */
  876.     apr_table_t *notes;
  877.  
  878.     /* content_type, handler, content_encoding, and all content_languages 
  879.      * MUST be lowercased strings.  They may be pointers to static strings;
  880.      * they should not be modified in place.
  881.      */
  882.     /** The content-type for the current request */
  883.     const char *content_type;    /* Break these out --- we dispatch on 'em */
  884.     /** The handler string that we use to call a handler function */
  885.     const char *handler;    /* What we *really* dispatch on */
  886.  
  887.     /** How to encode the data */
  888.     const char *content_encoding;
  889.     /** Array of strings representing the content languages */
  890.     apr_array_header_t *content_languages;
  891.  
  892.     /** variant list validator (if negotiated) */
  893.     char *vlist_validator;
  894.     
  895.     /** If an authentication check was made, this gets set to the user name. */
  896.     char *user;    
  897.     /** If an authentication check was made, this gets set to the auth type. */
  898.     char *ap_auth_type;
  899.  
  900.     /** This response can not be cached */
  901.     int no_cache;
  902.     /** There is no local copy of this response */
  903.     int no_local_copy;
  904.  
  905.     /* What object is being requested (either directly, or via include
  906.      * or content-negotiation mapping).
  907.      */
  908.  
  909.     /** The URI without any parsing performed */
  910.     char *unparsed_uri;    
  911.     /** The path portion of the URI */
  912.     char *uri;
  913.     /** The filename on disk corresponding to this response */
  914.     char *filename;
  915.     /* XXX: What does this mean? Please define "canonicalize" -aaron */
  916.     /** The true filename, we canonicalize r->filename if these don't match */
  917.     char *canonical_filename;
  918.     /** The PATH_INFO extracted from this request */
  919.     char *path_info;
  920.     /** The QUERY_ARGS extracted from this request */
  921.     char *args;    
  922.     /**  finfo.protection (st_mode) set to zero if no such file */
  923.     apr_finfo_t finfo;
  924.     /** A struct containing the components of URI */
  925.     apr_uri_t parsed_uri;
  926.  
  927.     /**
  928.      * Flag for the handler to accept or reject path_info on 
  929.      * the current request.  All modules should respect the
  930.      * AP_REQ_ACCEPT_PATH_INFO and AP_REQ_REJECT_PATH_INFO 
  931.      * values, while AP_REQ_DEFAULT_PATH_INFO indicates they
  932.      * may follow existing conventions.  This is set to the
  933.      * user's preference upon HOOK_VERY_FIRST of the fixups.
  934.      */
  935.     int used_path_info;
  936.  
  937.     /* Various other config info which may change with .htaccess files
  938.      * These are config vectors, with one void* pointer for each module
  939.      * (the thing pointed to being the module's business).
  940.      */
  941.  
  942.     /** Options set in config files, etc. */
  943.     struct ap_conf_vector_t *per_dir_config;
  944.     /** Notes on *this* request */
  945.     struct ap_conf_vector_t *request_config;
  946.  
  947.     /**
  948.      * A linked list of the .htaccess configuration directives
  949.      * accessed by this request.
  950.      * N.B. always add to the head of the list, _never_ to the end.
  951.      * that way, a sub request's list can (temporarily) point to a parent's list
  952.      */
  953.     const struct htaccess_result *htaccess;
  954.  
  955.     /** A list of output filters to be used for this request */
  956.     struct ap_filter_t *output_filters;
  957.     /** A list of input filters to be used for this request */
  958.     struct ap_filter_t *input_filters;
  959.  
  960.     /** A list of protocol level output filters to be used for this
  961.      *  request */
  962.     struct ap_filter_t *proto_output_filters;
  963.     /** A list of protocol level input filters to be used for this
  964.      *  request */
  965.     struct ap_filter_t *proto_input_filters;
  966.  
  967.     /** A flag to determine if the eos bucket has been sent yet */
  968.     int eos_sent;
  969.  
  970. /* Things placed at the end of the record to avoid breaking binary
  971.  * compatibility.  It would be nice to remember to reorder the entire
  972.  * record to improve 64bit alignment the next time we need to break
  973.  * binary compatibility for some other reason.
  974.  */
  975. };
  976.  
  977. /**
  978.  * @defgroup ProxyReq Proxy request types
  979.  *
  980.  * Possible values of request_rec->proxyreq. A request could be normal,
  981.  *  proxied or reverse proxied. Normally proxied and reverse proxied are
  982.  *  grouped together as just "proxied", but sometimes it's necessary to
  983.  *  tell the difference between the two, such as for authentication.
  984.  * @{
  985.  */
  986.  
  987. #define PROXYREQ_NONE 0        /**< No proxy */
  988. #define PROXYREQ_PROXY 1    /**< Standard proxy */
  989. #define PROXYREQ_REVERSE 2    /**< Reverse proxy */
  990. #define PROXYREQ_RESPONSE 3 /**< Origin response */
  991.  
  992. /* @} */
  993.  
  994. /**
  995.  * @brief Enumeration of connection keepalive options
  996.  */
  997. typedef enum {
  998.     AP_CONN_UNKNOWN,
  999.     AP_CONN_CLOSE,
  1000.     AP_CONN_KEEPALIVE
  1001. } ap_conn_keepalive_e;
  1002.  
  1003. /** 
  1004.  * @brief Structure to store things which are per connection 
  1005.  */
  1006. struct conn_rec {
  1007.     /** Pool associated with this connection */
  1008.     apr_pool_t *pool;
  1009.     /** Physical vhost this conn came in on */
  1010.     server_rec *base_server;
  1011.     /** used by http_vhost.c */
  1012.     void *vhost_lookup_data;
  1013.  
  1014.     /* Information about the connection itself */
  1015.     /** local address */
  1016.     apr_sockaddr_t *local_addr;
  1017.     /** remote address */
  1018.     apr_sockaddr_t *remote_addr;
  1019.  
  1020.     /** Client's IP address */
  1021.     char *remote_ip;
  1022.     /** Client's DNS name, if known.  NULL if DNS hasn't been checked,
  1023.      *  "" if it has and no address was found.  N.B. Only access this though
  1024.      * get_remote_host() */
  1025.     char *remote_host;
  1026.     /** Only ever set if doing rfc1413 lookups.  N.B. Only access this through
  1027.      *  get_remote_logname() */
  1028.     char *remote_logname;
  1029.  
  1030.     /** Are we still talking? */
  1031.     unsigned aborted:1;
  1032.  
  1033.     /** Are we going to keep the connection alive for another request?
  1034.      * @see ap_conn_keepalive_e */
  1035.     ap_conn_keepalive_e keepalive;
  1036.  
  1037.     /** have we done double-reverse DNS? -1 yes/failure, 0 not yet, 
  1038.      *  1 yes/success */
  1039.     signed int double_reverse:2;
  1040.  
  1041.     /** How many times have we used it? */
  1042.     int keepalives;
  1043.     /** server IP address */
  1044.     char *local_ip;
  1045.     /** used for ap_get_server_name when UseCanonicalName is set to DNS
  1046.      *  (ignores setting of HostnameLookups) */
  1047.     char *local_host;
  1048.  
  1049.     /** ID of this connection; unique at any point in time */
  1050.     long id; 
  1051.     /** Config vector containing pointers to connections per-server
  1052.      *  config structures. */
  1053.     struct ap_conf_vector_t *conn_config;
  1054.     /** Notes on *this* connection: send note from one module to
  1055.      *  another. must remain valid for all requests on this conn */
  1056.     apr_table_t *notes;
  1057.     /** A list of input filters to be used for this connection */
  1058.     struct ap_filter_t *input_filters;
  1059.     /** A list of output filters to be used for this connection */
  1060.     struct ap_filter_t *output_filters;
  1061.     /** handle to scoreboard information for this connection */
  1062.     void *sbh;
  1063.     /** The bucket allocator to use for all bucket/brigade creations */
  1064.     struct apr_bucket_alloc_t *bucket_alloc;
  1065.     /** The current state of this connection */
  1066.     conn_state_t *cs;
  1067.     /** Is there data pending in the input filters? */ 
  1068.     int data_in_input_filters;
  1069. };
  1070.  
  1071. /** 
  1072.  * Enumeration of connection states 
  1073.  */
  1074. typedef enum  {
  1075.     CONN_STATE_CHECK_REQUEST_LINE_READABLE,
  1076.     CONN_STATE_READ_REQUEST_LINE,
  1077.     CONN_STATE_LINGER
  1078. } conn_state_e;
  1079.  
  1080. /** 
  1081.  * @brief A structure to contain connection state information 
  1082.  */
  1083. struct conn_state_t {
  1084.     /** APR_RING of expiration timeouts */
  1085.     APR_RING_ENTRY(conn_state_t) timeout_list;
  1086.     /** the expiration time of the next keepalive timeout */
  1087.     apr_time_t expiration_time;
  1088.     /** Current state of the connection */
  1089.     conn_state_e state;
  1090.     /** connection record this struct refers to */
  1091.     conn_rec *c;
  1092.     /** memory pool to allocate from */
  1093.     apr_pool_t *p;
  1094.     /** bucket allocator */
  1095.     apr_bucket_alloc_t *bucket_alloc;
  1096.     /** poll file decriptor information */
  1097.     apr_pollfd_t pfd;
  1098. };
  1099.  
  1100. /* Per-vhost config... */
  1101.  
  1102. /**
  1103.  * The address 255.255.255.255, when used as a virtualhost address,
  1104.  * will become the "default" server when the ip doesn't match other vhosts.
  1105.  */
  1106. #define DEFAULT_VHOST_ADDR 0xfffffffful
  1107.  
  1108.  
  1109. /**
  1110.  * @struct server_addr_rec
  1111.  * @brief  A structure to be used for Per-vhost config 
  1112.  */
  1113. typedef struct server_addr_rec server_addr_rec;
  1114. struct server_addr_rec {
  1115.     /** The next server in the list */
  1116.     server_addr_rec *next;
  1117.     /** The bound address, for this server */
  1118.     apr_sockaddr_t *host_addr;
  1119.     /** The bound port, for this server */
  1120.     apr_port_t host_port;
  1121.     /** The name given in "<VirtualHost>" */
  1122.     char *virthost;
  1123. };
  1124.  
  1125. /** 
  1126.  * @brief A structure to store information for each virtual server 
  1127.  */
  1128. struct server_rec {
  1129.     /** The process this server is running in */
  1130.     process_rec *process;
  1131.     /** The next server in the list */
  1132.     server_rec *next;
  1133.  
  1134.     /** The name of the server */
  1135.     const char *defn_name;
  1136.     /** The line of the config file that the server was defined on */
  1137.     unsigned defn_line_number;
  1138.  
  1139.     /* Contact information */
  1140.  
  1141.     /** The admin's contact information */
  1142.     char *server_admin;
  1143.     /** The server hostname */
  1144.     char *server_hostname;
  1145.     /** for redirects, etc. */
  1146.     apr_port_t port;
  1147.  
  1148.     /* Log files --- note that transfer log is now in the modules... */
  1149.  
  1150.     /** The name of the error log */
  1151.     char *error_fname;
  1152.     /** A file descriptor that references the error log */
  1153.     apr_file_t *error_log;
  1154.     /** The log level for this server */
  1155.     int loglevel;
  1156.  
  1157.     /* Module-specific configuration for server, and defaults... */
  1158.  
  1159.     /** true if this is the virtual server */
  1160.     int is_virtual;
  1161.     /** Config vector containing pointers to modules' per-server config 
  1162.      *  structures. */
  1163.     struct ap_conf_vector_t *module_config; 
  1164.     /** MIME type info, etc., before we start checking per-directory info */
  1165.     struct ap_conf_vector_t *lookup_defaults;
  1166.  
  1167.     /* Transaction handling */
  1168.  
  1169.     /** I haven't got a clue */
  1170.     server_addr_rec *addrs;
  1171.     /** Timeout, as an apr interval, before we give up */
  1172.     apr_interval_time_t timeout;
  1173.     /** The apr interval we will wait for another request */
  1174.     apr_interval_time_t keep_alive_timeout;
  1175.     /** Maximum requests per connection */
  1176.     int keep_alive_max;
  1177.     /** Use persistent connections? */
  1178.     int keep_alive;
  1179.  
  1180.     /** Pathname for ServerPath */
  1181.     const char *path;
  1182.     /** Length of path */
  1183.     int pathlen;
  1184.  
  1185.     /** Normal names for ServerAlias servers */
  1186.     apr_array_header_t *names;
  1187.     /** Wildcarded names for ServerAlias servers */
  1188.     apr_array_header_t *wild_names;
  1189.  
  1190.     /** limit on size of the HTTP request line    */
  1191.     int limit_req_line;
  1192.     /** limit on size of any request header field */
  1193.     int limit_req_fieldsize;
  1194.     /** limit on number of request header fields  */
  1195.     int limit_req_fields; 
  1196. };
  1197.  
  1198. typedef struct core_output_filter_ctx {
  1199.     apr_bucket_brigade *b;
  1200.     /** subpool of c->pool used for resources 
  1201.      * which may outlive the request
  1202.      */
  1203.     apr_pool_t *deferred_write_pool;
  1204. } core_output_filter_ctx_t;
  1205.  
  1206. typedef struct core_filter_ctx {
  1207.     apr_bucket_brigade *b;
  1208.     apr_bucket_brigade *tmpbb;
  1209. } core_ctx_t;
  1210.  
  1211. typedef struct core_net_rec {
  1212.     /** Connection to the client */
  1213.     apr_socket_t *client_socket;
  1214.  
  1215.     /** connection record */
  1216.     conn_rec *c;
  1217.  
  1218.     core_output_filter_ctx_t *out_ctx;
  1219.     core_ctx_t *in_ctx;
  1220. } core_net_rec;
  1221.  
  1222. /**
  1223.  * Examine a field value (such as a media-/content-type) string and return
  1224.  * it sans any parameters; e.g., strip off any ';charset=foo' and the like.
  1225.  * @param p Pool to allocate memory from
  1226.  * @param intype The field to examine
  1227.  * @return A copy of the field minus any parameters
  1228.  */
  1229. AP_DECLARE(char *) ap_field_noparam(apr_pool_t *p, const char *intype);
  1230.  
  1231. /**
  1232.  * Convert a time from an integer into a string in a specified format
  1233.  * @param p The pool to allocate memory from
  1234.  * @param t The time to convert
  1235.  * @param fmt The format to use for the conversion
  1236.  * @param gmt Convert the time for GMT?
  1237.  * @return The string that represents the specified time
  1238.  */
  1239. AP_DECLARE(char *) ap_ht_time(apr_pool_t *p, apr_time_t t, const char *fmt, int gmt);
  1240.  
  1241. /* String handling. The *_nc variants allow you to use non-const char **s as
  1242.    arguments (unfortunately C won't automatically convert a char ** to a const
  1243.    char **) */
  1244.  
  1245. /**
  1246.  * Get the characters until the first occurance of a specified character
  1247.  * @param p The pool to allocate memory from
  1248.  * @param line The string to get the characters from
  1249.  * @param stop The character to stop at
  1250.  * @return A copy of the characters up to the first stop character
  1251.  */
  1252. AP_DECLARE(char *) ap_getword(apr_pool_t *p, const char **line, char stop);
  1253.  
  1254. /**
  1255.  * Get the characters until the first occurance of a specified character
  1256.  * @param p The pool to allocate memory from
  1257.  * @param line The string to get the characters from
  1258.  * @param stop The character to stop at
  1259.  * @return A copy of the characters up to the first stop character
  1260.  * @note This is the same as ap_getword(), except it doesn't use const char **.
  1261.  */
  1262. AP_DECLARE(char *) ap_getword_nc(apr_pool_t *p, char **line, char stop);
  1263.  
  1264. /**
  1265.  * Get the first word from a given string.  A word is defined as all characters
  1266.  * up to the first whitespace.
  1267.  * @param p The pool to allocate memory from
  1268.  * @param line The string to traverse
  1269.  * @return The first word in the line
  1270.  */
  1271. AP_DECLARE(char *) ap_getword_white(apr_pool_t *p, const char **line);
  1272.  
  1273. /**
  1274.  * Get the first word from a given string.  A word is defined as all characters
  1275.  * up to the first whitespace.
  1276.  * @param p The pool to allocate memory from
  1277.  * @param line The string to traverse
  1278.  * @return The first word in the line
  1279.  * @note The same as ap_getword_white(), except it doesn't use const char**
  1280.  */
  1281. AP_DECLARE(char *) ap_getword_white_nc(apr_pool_t *p, char **line);
  1282.  
  1283. /**
  1284.  * Get all characters from the first occurance of @a stop to the first "\0"
  1285.  * @param p The pool to allocate memory from
  1286.  * @param line The line to traverse
  1287.  * @param stop The character to start at
  1288.  * @return A copy of all caracters after the first occurance of the specified
  1289.  *         character
  1290.  */
  1291. AP_DECLARE(char *) ap_getword_nulls(apr_pool_t *p, const char **line,
  1292.                     char stop);
  1293.  
  1294. /**
  1295.  * Get all characters from the first occurance of @a stop to the first "\0"
  1296.  * @param p The pool to allocate memory from
  1297.  * @param line The line to traverse
  1298.  * @param stop The character to start at
  1299.  * @return A copy of all caracters after the first occurance of the specified
  1300.  *         character
  1301.  * @note The same as ap_getword_nulls(), except it doesn't use const char **.
  1302.  */
  1303. AP_DECLARE(char *) ap_getword_nulls_nc(apr_pool_t *p, char **line, char stop);
  1304.  
  1305. /**
  1306.  * Get the second word in the string paying attention to quoting
  1307.  * @param p The pool to allocate from
  1308.  * @param line The line to traverse
  1309.  * @return A copy of the string
  1310.  */
  1311. AP_DECLARE(char *) ap_getword_conf(apr_pool_t *p, const char **line);
  1312.  
  1313. /**
  1314.  * Get the second word in the string paying attention to quoting
  1315.  * @param p The pool to allocate from
  1316.  * @param line The line to traverse
  1317.  * @return A copy of the string
  1318.  * @note The same as ap_getword_conf(), except it doesn't use const char **.
  1319.  */
  1320. AP_DECLARE(char *) ap_getword_conf_nc(apr_pool_t *p, char **line);
  1321.  
  1322. /**
  1323.  * Check a string for any ${ENV} environment variable construct and replace 
  1324.  * each them by the value of that environment variable, if it exists. If the 
  1325.  * environment value does not exist, leave the ${ENV} construct alone; it 
  1326.  * means something else.
  1327.  * @param p The pool to allocate from
  1328.  * @param word The string to check
  1329.  * @return The string with the replaced environment variables
  1330.  */
  1331. AP_DECLARE(const char *) ap_resolve_env(apr_pool_t *p, const char * word); 
  1332.  
  1333. /**
  1334.  * Size an HTTP header field list item, as separated by a comma.
  1335.  * @param field The field to size
  1336.  * @param len The length of the field
  1337.  * @return The return value is a pointer to the beginning of the non-empty 
  1338.  * list item within the original string (or NULL if there is none) and the 
  1339.  * address of field is shifted to the next non-comma, non-whitespace 
  1340.  * character.  len is the length of the item excluding any beginning whitespace.
  1341.  */
  1342. AP_DECLARE(const char *) ap_size_list_item(const char **field, int *len);
  1343.  
  1344. /**
  1345.  * Retrieve an HTTP header field list item, as separated by a comma,
  1346.  * while stripping insignificant whitespace and lowercasing anything not in
  1347.  * a quoted string or comment.  
  1348.  * @param p The pool to allocate from
  1349.  * @param field The field to retrieve
  1350.  * @return The return value is a new string containing the converted list 
  1351.  *         item (or NULL if none) and the address pointed to by field is 
  1352.  *         shifted to the next non-comma, non-whitespace.
  1353.  */
  1354. AP_DECLARE(char *) ap_get_list_item(apr_pool_t *p, const char **field);
  1355.  
  1356. /**
  1357.  * Find an item in canonical form (lowercase, no extra spaces) within
  1358.  * an HTTP field value list.  
  1359.  * @param p The pool to allocate from
  1360.  * @param line The field value list to search
  1361.  * @param tok The token to search for
  1362.  * @return 1 if found, 0 if not found.
  1363.  */
  1364. AP_DECLARE(int) ap_find_list_item(apr_pool_t *p, const char *line, const char *tok);
  1365.  
  1366. /**
  1367.  * Retrieve a token, spacing over it and adjusting the pointer to
  1368.  * the first non-white byte afterwards.  Note that these tokens
  1369.  * are delimited by semis and commas and can also be delimited
  1370.  * by whitespace at the caller's option.
  1371.  * @param p The pool to allocate from
  1372.  * @param accept_line The line to retrieve the token from (adjusted afterwards)
  1373.  * @param accept_white Is it delimited by whitespace
  1374.  * @return the token
  1375.  */
  1376. AP_DECLARE(char *) ap_get_token(apr_pool_t *p, const char **accept_line, int accept_white);
  1377.  
  1378. /**
  1379.  * Find http tokens, see the definition of token from RFC2068 
  1380.  * @param p The pool to allocate from
  1381.  * @param line The line to find the token
  1382.  * @param tok The token to find
  1383.  * @return 1 if the token is found, 0 otherwise
  1384.  */
  1385. AP_DECLARE(int) ap_find_token(apr_pool_t *p, const char *line, const char *tok);
  1386.  
  1387. /**
  1388.  * find http tokens from the end of the line
  1389.  * @param p The pool to allocate from
  1390.  * @param line The line to find the token
  1391.  * @param tok The token to find
  1392.  * @return 1 if the token is found, 0 otherwise
  1393.  */
  1394. AP_DECLARE(int) ap_find_last_token(apr_pool_t *p, const char *line, const char *tok);
  1395.  
  1396. /**
  1397.  * Check for an Absolute URI syntax
  1398.  * @param u The string to check
  1399.  * @return 1 if URI, 0 otherwise
  1400.  */
  1401. AP_DECLARE(int) ap_is_url(const char *u);
  1402.  
  1403. /**
  1404.  * Unescape a URL
  1405.  * @param url The url to unescape
  1406.  * @return 0 on success, non-zero otherwise
  1407.  */
  1408. AP_DECLARE(int) ap_unescape_url(char *url);
  1409.  
  1410. /**
  1411.  * Unescape a URL, but leaving %2f (slashes) escaped
  1412.  * @param url The url to unescape
  1413.  * @return 0 on success, non-zero otherwise
  1414.  */
  1415. AP_DECLARE(int) ap_unescape_url_keep2f(char *url);
  1416.  
  1417. /**
  1418.  * Convert all double slashes to single slashes
  1419.  * @param name The string to convert
  1420.  */
  1421. AP_DECLARE(void) ap_no2slash(char *name);
  1422.  
  1423. /**
  1424.  * Remove all ./ and xx/../ substrings from a file name. Also remove
  1425.  * any leading ../ or /../ substrings.
  1426.  * @param name the file name to parse
  1427.  */
  1428. AP_DECLARE(void) ap_getparents(char *name);
  1429.  
  1430. /**
  1431.  * Escape a path segment, as defined in RFC 1808
  1432.  * @param p The pool to allocate from
  1433.  * @param s The path to convert
  1434.  * @return The converted URL
  1435.  */
  1436. AP_DECLARE(char *) ap_escape_path_segment(apr_pool_t *p, const char *s);
  1437.  
  1438. /**
  1439.  * convert an OS path to a URL in an OS dependant way.
  1440.  * @param p The pool to allocate from
  1441.  * @param path The path to convert
  1442.  * @param partial if set, assume that the path will be appended to something
  1443.  *        with a '/' in it (and thus does not prefix "./")
  1444.  * @return The converted URL
  1445.  */
  1446. AP_DECLARE(char *) ap_os_escape_path(apr_pool_t *p, const char *path, int partial);
  1447.  
  1448. /** @see ap_os_escape_path */
  1449. #define ap_escape_uri(ppool,path) ap_os_escape_path(ppool,path,1)
  1450.  
  1451. /**
  1452.  * Escape an html string
  1453.  * @param p The pool to allocate from
  1454.  * @param s The html to escape
  1455.  * @return The escaped string
  1456.  */
  1457. AP_DECLARE(char *) ap_escape_html(apr_pool_t *p, const char *s);
  1458.  
  1459. /**
  1460.  * Escape a string for logging
  1461.  * @param p The pool to allocate from
  1462.  * @param str The string to escape
  1463.  * @return The escaped string
  1464.  */
  1465. AP_DECLARE(char *) ap_escape_logitem(apr_pool_t *p, const char *str);
  1466.  
  1467. /**
  1468.  * Escape a string for logging into the error log (without a pool)
  1469.  * @param dest The buffer to write to
  1470.  * @param source The string to escape
  1471.  * @param buflen The buffer size for the escaped string (including "\0")
  1472.  * @return The len of the escaped string (always < maxlen)
  1473.  */
  1474. AP_DECLARE(apr_size_t) ap_escape_errorlog_item(char *dest, const char *source,
  1475.                                                apr_size_t buflen);
  1476.  
  1477. /**
  1478.  * Construct a full hostname
  1479.  * @param p The pool to allocate from
  1480.  * @param hostname The hostname of the server
  1481.  * @param port The port the server is running on
  1482.  * @param r The current request
  1483.  * @return The server's hostname
  1484.  */
  1485. AP_DECLARE(char *) ap_construct_server(apr_pool_t *p, const char *hostname,
  1486.                     apr_port_t port, const request_rec *r);
  1487.  
  1488. /**
  1489.  * Escape a shell command
  1490.  * @param p The pool to allocate from
  1491.  * @param s The command to escape
  1492.  * @return The escaped shell command
  1493.  */
  1494. AP_DECLARE(char *) ap_escape_shell_cmd(apr_pool_t *p, const char *s);
  1495.  
  1496. /**
  1497.  * Count the number of directories in a path
  1498.  * @param path The path to count
  1499.  * @return The number of directories
  1500.  */
  1501. AP_DECLARE(int) ap_count_dirs(const char *path);
  1502.  
  1503. /**
  1504.  * Copy at most @a n leading directories of @a s into @a d. @a d
  1505.  * should be at least as large as @a s plus 1 extra byte
  1506.  *
  1507.  * @param d The location to copy to
  1508.  * @param s The location to copy from
  1509.  * @param n The number of directories to copy
  1510.  * @return value is the ever useful pointer to the trailing "\0" of d
  1511.  * @note on platforms with drive letters, n = 0 returns the "/" root, 
  1512.  * whereas n = 1 returns the "d:/" root.  On all other platforms, n = 0
  1513.  * returns the empty string.  */
  1514. AP_DECLARE(char *) ap_make_dirstr_prefix(char *d, const char *s, int n);
  1515.  
  1516. /**
  1517.  * Return the parent directory name (including trailing /) of the file
  1518.  * @a s
  1519.  * @param p The pool to allocate from
  1520.  * @param s The file to get the parent of
  1521.  * @return A copy of the file's parent directory
  1522.  */
  1523. AP_DECLARE(char *) ap_make_dirstr_parent(apr_pool_t *p, const char *s);
  1524.  
  1525. /**
  1526.  * Given a directory and filename, create a single path from them.  This
  1527.  * function is smart enough to ensure that there is a sinlge '/' between the
  1528.  * directory and file names
  1529.  * @param a The pool to allocate from
  1530.  * @param dir The directory name
  1531.  * @param f The filename
  1532.  * @return A copy of the full path
  1533.  * @note Never consider using this function if you are dealing with filesystem
  1534.  * names that need to remain canonical, unless you are merging an apr_dir_read
  1535.  * path and returned filename.  Otherwise, the result is not canonical.
  1536.  */
  1537. AP_DECLARE(char *) ap_make_full_path(apr_pool_t *a, const char *dir, const char *f);
  1538.  
  1539. /**
  1540.  * Test if the given path has an an absolute path.
  1541.  * @param p The pool to allocate from
  1542.  * @param dir The directory name
  1543.  * @note The converse is not necessarily true, some OS's (Win32/OS2/Netware) have
  1544.  * multiple forms of absolute paths.  This only reports if the path is absolute
  1545.  * in a canonical sense.
  1546.  */
  1547. AP_DECLARE(int) ap_os_is_path_absolute(apr_pool_t *p, const char *dir);
  1548.  
  1549. /**
  1550.  * Does the provided string contain wildcard characters?  This is useful
  1551.  * for determining if the string should be passed to strcmp_match or to strcmp.
  1552.  * The only wildcard characters recognized are '?' and '*'
  1553.  * @param str The string to check
  1554.  * @return 1 if the string has wildcards, 0 otherwise
  1555.  */
  1556. AP_DECLARE(int) ap_is_matchexp(const char *str);
  1557.  
  1558. /**
  1559.  * Determine if a string matches a patterm containing the wildcards '?' or '*'
  1560.  * @param str The string to check
  1561.  * @param expected The pattern to match against
  1562.  * @return 1 if the two strings match, 0 otherwise
  1563.  */
  1564. AP_DECLARE(int) ap_strcmp_match(const char *str, const char *expected);
  1565.  
  1566. /**
  1567.  * Determine if a string matches a patterm containing the wildcards '?' or '*',
  1568.  * ignoring case
  1569.  * @param str The string to check
  1570.  * @param expected The pattern to match against
  1571.  * @return 1 if the two strings match, 0 otherwise
  1572.  */
  1573. AP_DECLARE(int) ap_strcasecmp_match(const char *str, const char *expected);
  1574.  
  1575. /**
  1576.  * Find the first occurrence of the substring s2 in s1, regardless of case
  1577.  * @param s1 The string to search
  1578.  * @param s2 The substring to search for
  1579.  * @return A pointer to the beginning of the substring
  1580.  * @remark See apr_strmatch() for a faster alternative
  1581.  */
  1582. AP_DECLARE(char *) ap_strcasestr(const char *s1, const char *s2);
  1583.  
  1584. /**
  1585.  * Return a pointer to the location inside of bigstring immediately after prefix
  1586.  * @param bigstring The input string
  1587.  * @param prefix The prefix to strip away
  1588.  * @return A pointer relative to bigstring after prefix
  1589.  */
  1590. AP_DECLARE(const char *) ap_stripprefix(const char *bigstring,
  1591.                                         const char *prefix);
  1592.  
  1593. /**
  1594.  * Decode a base64 encoded string into memory allocated from a pool
  1595.  * @param p The pool to allocate from
  1596.  * @param bufcoded The encoded string
  1597.  * @return The decoded string
  1598.  */
  1599. AP_DECLARE(char *) ap_pbase64decode(apr_pool_t *p, const char *bufcoded);
  1600.  
  1601. /**
  1602.  * Encode a string into memory allocated from a pool in base 64 format
  1603.  * @param p The pool to allocate from
  1604.  * @param string The plaintext string
  1605.  * @return The encoded string
  1606.  */
  1607. AP_DECLARE(char *) ap_pbase64encode(apr_pool_t *p, char *string); 
  1608.  
  1609. /**
  1610.  * Compile a regular expression to be used later
  1611.  * @param p The pool to allocate from
  1612.  * @param pattern the regular expression to compile
  1613.  * @param cflags The bitwise or of one or more of the following:
  1614.  *   @li REG_EXTENDED - Use POSIX extended Regular Expressions
  1615.  *   @li REG_ICASE    - Ignore case
  1616.  *   @li REG_NOSUB    - Support for substring addressing of matches
  1617.  *       not required
  1618.  *   @li REG_NEWLINE  - Match-any-character operators don't match new-line
  1619.  * @return The compiled regular expression
  1620.  */
  1621. AP_DECLARE(ap_regex_t *) ap_pregcomp(apr_pool_t *p, const char *pattern,
  1622.                                      int cflags);
  1623.  
  1624. /**
  1625.  * Free the memory associated with a compiled regular expression
  1626.  * @param p The pool the regex was allocated from
  1627.  * @param reg The regular expression to free
  1628.  */
  1629. AP_DECLARE(void) ap_pregfree(apr_pool_t *p, ap_regex_t *reg);
  1630.  
  1631. /**
  1632.  * After performing a successful regex match, you may use this function to 
  1633.  * perform a series of string substitutions based on subexpressions that were
  1634.  * matched during the call to ap_regexec
  1635.  * @param p The pool to allocate from
  1636.  * @param input An arbitrary string containing $1 through $9.  These are 
  1637.  *              replaced with the corresponding matched sub-expressions
  1638.  * @param source The string that was originally matched to the regex
  1639.  * @param nmatch the nmatch returned from ap_pregex
  1640.  * @param pmatch the pmatch array returned from ap_pregex
  1641.  */
  1642. AP_DECLARE(char *) ap_pregsub(apr_pool_t *p, const char *input, const char *source,
  1643.                               size_t nmatch, ap_regmatch_t pmatch[]);
  1644.  
  1645. /**
  1646.  * We want to downcase the type/subtype for comparison purposes
  1647.  * but nothing else because ;parameter=foo values are case sensitive.
  1648.  * @param s The content-type to convert to lowercase
  1649.  */
  1650. AP_DECLARE(void) ap_content_type_tolower(char *s);
  1651.  
  1652. /**
  1653.  * convert a string to all lowercase
  1654.  * @param s The string to convert to lowercase 
  1655.  */
  1656. AP_DECLARE(void) ap_str_tolower(char *s);
  1657.  
  1658. /**
  1659.  * Search a string from left to right for the first occurrence of a 
  1660.  * specific character
  1661.  * @param str The string to search
  1662.  * @param c The character to search for
  1663.  * @return The index of the first occurrence of c in str
  1664.  */
  1665. AP_DECLARE(int) ap_ind(const char *str, char c);    /* Sigh... */
  1666.  
  1667. /**
  1668.  * Search a string from right to left for the first occurrence of a 
  1669.  * specific character
  1670.  * @param str The string to search
  1671.  * @param c The character to search for
  1672.  * @return The index of the first occurrence of c in str
  1673.  */
  1674. AP_DECLARE(int) ap_rind(const char *str, char c);
  1675.  
  1676. /**
  1677.  * Given a string, replace any bare " with \" .
  1678.  * @param p The pool to allocate memory from
  1679.  * @param instring The string to search for "
  1680.  * @return A copy of the string with escaped quotes 
  1681.  */
  1682. AP_DECLARE(char *) ap_escape_quotes(apr_pool_t *p, const char *instring);
  1683.  
  1684. /**
  1685.  * Given a string, append the PID deliminated by delim.
  1686.  * Usually used to create a pid-appended filepath name
  1687.  * (eg: /a/b/foo -> /a/b/foo.6726). A function, and not
  1688.  * a macro, to avoid unistd.h dependency
  1689.  * @param p The pool to allocate memory from
  1690.  * @param string The string to append the PID to
  1691.  * @param delim The string to use to deliminate the string from the PID
  1692.  * @return A copy of the string with the PID appended 
  1693.  */
  1694. AP_DECLARE(char *) ap_append_pid(apr_pool_t *p, const char *string,
  1695.                                  const char *delim);
  1696.  
  1697. /* Misc system hackery */
  1698. /**
  1699.  * Given the name of an object in the file system determine if it is a directory
  1700.  * @param p The pool to allocate from 
  1701.  * @param name The name of the object to check
  1702.  * @return 1 if it is a directory, 0 otherwise
  1703.  */
  1704. AP_DECLARE(int) ap_is_rdirectory(apr_pool_t *p, const char *name);
  1705.  
  1706. /**
  1707.  * Given the name of an object in the file system determine if it is a directory - this version is symlink aware
  1708.  * @param p The pool to allocate from 
  1709.  * @param name The name of the object to check
  1710.  * @return 1 if it is a directory, 0 otherwise
  1711.  */
  1712. AP_DECLARE(int) ap_is_directory(apr_pool_t *p, const char *name);
  1713.  
  1714. #ifdef _OSD_POSIX
  1715. extern int os_init_job_environment(server_rec *s, const char *user_name, int one_process);
  1716. #endif /* _OSD_POSIX */
  1717.  
  1718. /**
  1719.  * Determine the local host name for the current machine
  1720.  * @param p The pool to allocate from
  1721.  * @return A copy of the local host name
  1722.  */
  1723. char *ap_get_local_host(apr_pool_t *p);
  1724.  
  1725. /**
  1726.  * Log an assertion to the error log
  1727.  * @param szExp The assertion that failed
  1728.  * @param szFile The file the assertion is in
  1729.  * @param nLine The line the assertion is defined on
  1730.  */
  1731. AP_DECLARE(void) ap_log_assert(const char *szExp, const char *szFile, int nLine)
  1732.                 __attribute__((noreturn));
  1733.  
  1734. /** 
  1735.  * @internal Internal Assert function
  1736.  */
  1737. #define ap_assert(exp) ((exp) ? (void)0 : ap_log_assert(#exp,__FILE__,__LINE__))
  1738.  
  1739. /**
  1740.  * Redefine assert() to something more useful for an Apache...
  1741.  *
  1742.  * Use ap_assert() if the condition should always be checked.
  1743.  * Use AP_DEBUG_ASSERT() if the condition should only be checked when AP_DEBUG
  1744.  * is defined.
  1745.  */
  1746. #ifdef AP_DEBUG
  1747. #define AP_DEBUG_ASSERT(exp) ap_assert(exp)
  1748. #else
  1749. #define AP_DEBUG_ASSERT(exp) ((void)0)
  1750. #endif
  1751.  
  1752. /**
  1753.  * @defgroup stopsignal Flags which indicate places where the sever should stop for debugging.
  1754.  * @{
  1755.  * A set of flags which indicate places where the server should raise(SIGSTOP).
  1756.  * This is useful for debugging, because you can then attach to that process
  1757.  * with gdb and continue.  This is important in cases where one_process
  1758.  * debugging isn't possible.
  1759.  */
  1760. /** stop on a Detach */
  1761. #define SIGSTOP_DETACH            1
  1762. /** stop making a child process */
  1763. #define SIGSTOP_MAKE_CHILD        2
  1764. /** stop spawning a child process */
  1765. #define SIGSTOP_SPAWN_CHILD        4
  1766. /** stop spawning a child process with a piped log */
  1767. #define SIGSTOP_PIPED_LOG_SPAWN        8
  1768. /** stop spawning a CGI child process */
  1769. #define SIGSTOP_CGI_CHILD        16
  1770.  
  1771. /** Macro to get GDB started */
  1772. #ifdef DEBUG_SIGSTOP
  1773. extern int raise_sigstop_flags;
  1774. #define RAISE_SIGSTOP(x)    do { \
  1775.     if (raise_sigstop_flags & SIGSTOP_##x) raise(SIGSTOP);\
  1776.     } while (0)
  1777. #else
  1778. #define RAISE_SIGSTOP(x)
  1779. #endif
  1780. /** @} */
  1781. /**
  1782.  * Get HTML describing the address and (optionally) admin of the server.
  1783.  * @param prefix Text which is prepended to the return value
  1784.  * @param r The request_rec
  1785.  * @return HTML describing the server, allocated in @a r's pool.
  1786.  */
  1787. AP_DECLARE(const char *) ap_psignature(const char *prefix, request_rec *r);
  1788.  
  1789. /** strtoul does not exist on sunos4. */
  1790. #ifdef strtoul
  1791. #undef strtoul
  1792. #endif
  1793. #define strtoul strtoul_is_not_a_portable_function_use_strtol_instead
  1794.  
  1795.   /* The C library has functions that allow const to be silently dropped ...
  1796.      these macros detect the drop in maintainer mode, but use the native
  1797.      methods for normal builds
  1798.  
  1799.      Note that on some platforms (e.g., AIX with gcc, Solaris with gcc), string.h needs 
  1800.      to be included before the macros are defined or compilation will fail.
  1801.   */
  1802. #include <string.h>
  1803.  
  1804. AP_DECLARE(char *) ap_strchr(char *s, int c);
  1805. AP_DECLARE(const char *) ap_strchr_c(const char *s, int c);
  1806. AP_DECLARE(char *) ap_strrchr(char *s, int c);
  1807. AP_DECLARE(const char *) ap_strrchr_c(const char *s, int c);
  1808. AP_DECLARE(char *) ap_strstr(char *s, const char *c);
  1809. AP_DECLARE(const char *) ap_strstr_c(const char *s, const char *c);
  1810.  
  1811. #ifdef AP_DEBUG
  1812.  
  1813. #undef strchr
  1814. # define strchr(s, c)    ap_strchr(s,c)
  1815. #undef strrchr
  1816. # define strrchr(s, c)  ap_strrchr(s,c)
  1817. #undef strstr
  1818. # define strstr(s, c)  ap_strstr(s,c)
  1819.  
  1820. #else
  1821.  
  1822. /** use this instead of strchr */
  1823. # define ap_strchr(s, c)    strchr(s, c)
  1824. /** use this instead of strchr */
  1825. # define ap_strchr_c(s, c)    strchr(s, c)
  1826. /** use this instead of strrchr */
  1827. # define ap_strrchr(s, c)    strrchr(s, c)
  1828. /** use this instead of strrchr */
  1829. # define ap_strrchr_c(s, c)    strrchr(s, c)
  1830. /** use this instead of strrstr*/
  1831. # define ap_strstr(s, c)    strstr(s, c)
  1832. /** use this instead of strrstr*/
  1833. # define ap_strstr_c(s, c)    strstr(s, c)
  1834.  
  1835. #endif
  1836.  
  1837. #define AP_NORESTART        APR_OS_START_USEERR + 1
  1838.  
  1839. #ifdef __cplusplus
  1840. }
  1841. #endif
  1842.  
  1843. #endif    /* !APACHE_HTTPD_H */
  1844.  
  1845. /** @} //APACHE Daemon      */
  1846. /** @} //APACHE Core        */
  1847. /** @} //APACHE super group */
  1848.  
  1849.